audio_form object
This method will return the caption of a given control.
string get_caption(int control_id)
Parameters:
control_id
The ID of the control to retrieve the caption from.
Return value:
The caption text on success, or an empty string on failure.
Remarks:
The caption text that is returned does not contain the & shortcut symbol. To retrieve the character which contains the shortcut, use the get_shortcut method.
Example:
// Make a simple form with a few buttons and a listbox.
#include "form.bgt"
audio_form form;
void main()
{
form.create_window("Example Form", true);
int list=form.create_list("&People", 0);
form.add_list_item(list, "Joseph", -1);
form.add_list_item(list, "Samuel", -1);
form.add_list_item(list, "Percival", 1);
form.add_list_item(list, "William", -1);
form.add_list_item(list, "Edward", 0);
int ok=form.create_button("OK");
int cancel=form.create_button("E&xit");
while(true)
{
form.monitor();
wait(5);
if(form.is_pressed(ok))
{
alert("Information", "The caption of the listbox is "+form.get_caption(list));
exit();
}
if(form.is_pressed(cancel))
{
exit();
}
if((key_down(KEY_LMENU))&&(key_pressed(KEY_F4)))
{
exit();
}
}
}